/* 
 * Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *      * The names of its contributors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package kameleon.gui;

/**
 * Contains the list and constants for the various supported
 * command line argument of the Kameleon software.
 * 
 * @author		Schnell Michaël
 * @version		1.0
 */
public interface ArgumentConstants {
	
	/**
	 * Enumeration of the supported command line arguments.
	 * 
	 * <p>Each element has a value ({@code String}) and a number of 
	 * parameters ({@code int}). Example:
	 * <pre>-arg1 param1 param2</pre>
	 * is coded with the value {@code "-arg1"} and a number of
	 * parameters of {@code 2}.
	 * 
	 * <p>A variable number of parameters
	 * is not supported.
	 * 
	 * @author		Schnell Michaël
	 * @version		1.0
	 */
	public enum Argument {
		/**
		 * Represents the debug mode. When found, the debug mode is activated.
		 */
		DEBUG("--debug", 0), //$NON-NLS-1$
		/**
		 * Represents the debug mode. When found, the debug mode is activated.
		 */
		PLUGIN("-plugin", 1) ; //$NON-NLS-1$
		
		/**
		 * Value of the command line argument.
		 */
		private String value ;
		
		/**
		 * Number of expected parameters for the given argument.
		 */
		private int nParameters ;
		
		/**
		 * Builds an instance with the given values.
		 * 
		 * @param 	value
		 * 			value of the command line argument
		 * 
		 * @param 	nParameters
		 * 			number of expected parameters
		 */
		Argument(String value, int nParameters) {
			this.value = value ;
			this.nParameters = nParameters ;
		}// Argument(String, int)
		
		/**
		 * Returns the value of this instance.
		 * 
		 * @return	Value of this instance
		 */
		public String getValue() {
			return this.value;
		}// getValue()
		
		/**
		 * Returns the expected number of parameters of this instance.
		 * 
		 * @return	Expected number of parameters of this instance
		 */
		public int getnParameters() {
			return this.nParameters;
		}// getnParameters()
		
	}// enum Argument

}// interface ArgumentConstants